API

System APIs

POST system/error-messages

Creates a new error-message. An english error-message is required.

HTTP method POST
URI https://api.rambase.net/system/error-messages
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 133, version 6

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ErrorMessage>
2
     <HttpStatusCode
HttpStatusCode

The HTTP Status Code that will be used when sending out the error-message (ex. 500, 404)

This field is optional.

>{Integer}</HttpStatusCode>
3
     <Message
Message

The english error-message

This field is optional.

>{String}</Message>
4
     <Namespace
Namespace

Namespace of the error message. Used for categorization only.

This field is optional.

>{String}</Namespace>
5
     <TechnicalDescription
TechnicalDescription

A techinical description describing causes of the error and solutions to the problem

This field is optional.

>{String}</TechnicalDescription>
6
     <Translations>
7
          <Translation>
8
               <Language
Language

Required/mandatory field

The language of the translated error-message

>{String}</Language>
9
               <TranslatedMessage
TranslatedMessage

Required/mandatory field

The translated error-message

>{String}</TranslatedMessage>
10
          </Translation>
11
     </Translations>
12
</ErrorMessage>
1
{
2
     "errorMessage": {
3
          "httpStatusCode
HttpStatusCode

The HTTP Status Code that will be used when sending out the error-message (ex. 500, 404)

This field is optional.

": "{Integer}",
4
          "message
Message

The english error-message

This field is optional.

": "{String}",
5
          "namespace
Namespace

Namespace of the error message. Used for categorization only.

This field is optional.

": "{String}",
6
          "technicalDescription
TechnicalDescription

A techinical description describing causes of the error and solutions to the problem

This field is optional.

": "{String}",
7
          "translations": [
8
               {
9
                    "language
Language

Required/mandatory field

The language of the translated error-message

": "{String}",
10
                    "translatedMessage
TranslatedMessage

Required/mandatory field

The translated error-message

": "{String}"
11
               }
12
          ]
13
     }
14
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ErrorMessage>
2
     <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
3
     <Status
Status

Object status of the errormessage

>{String}</Status>
4
     <Namespace
Namespace

Namespace of the error message. Used for categorization only.

>{String}</Namespace>
5
     <HttpStatusCode
HttpStatusCode

The HTTP Status Code that will be used when sending out the error-message (ex. 500, 404)

>{Integer}</HttpStatusCode>
6
     <Message
Message

The english error-message

>{String}</Message>
7
     <TechnicalDescription
TechnicalDescription

A techinical description describing causes of the error and solutions to the problem

>{String}</TechnicalDescription>
8
     <Repository>
9
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
10
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>{Integer}</ChangedBy>
11
          <Translation>
12
               <Language
Language

The language of the translated error-message

>{String}</Language>
13
               <TranslatedMessage
TranslatedMessage

The translated error-message

>{String}</TranslatedMessage>
14
          </Translation>
15
     </Repository>
16
</ErrorMessage>
1
{
2
     "errorMessage": {
3
          "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
4
          "status
Status

Object status of the errormessage

": "{String}",
5
          "namespace
Namespace

Namespace of the error message. Used for categorization only.

": "{String}",
6
          "httpStatusCode
HttpStatusCode

The HTTP Status Code that will be used when sending out the error-message (ex. 500, 404)

": "{Integer}",
7
          "message
Message

The english error-message

": "{String}",
8
          "technicalDescription
TechnicalDescription

A techinical description describing causes of the error and solutions to the problem

": "{String}",
9
          "repository": {
10
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
11
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": "{Integer}",
12
               "translation": {
13
                    "language
Language

The language of the translated error-message

": "{String}",
14
                    "translatedMessage
TranslatedMessage

The translated error-message

": "{String}"
15
               }
16
          }
17
     }
18
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found
Error 100037 HTTP 400 Message is required when language is specified
Error 100038 HTTP 400 Invalid language: {0}